home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / SA_INC.ZIP / RA_INC.DOC next >
Text File  |  1990-05-30  |  3KB  |  83 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.                            Inter-node communication spec
  7.                            ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  8.                                        for
  9.                                        ~~~
  10.                                 RemoteAccess 0.03
  11.                                 ~~~~~~~~~~~~~~~~~
  12.  
  13.                 (C) 1990 Continental Software, All rights reserved
  14.                 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15.  
  16.  
  17.  
  18.  
  19. INTRODUCTION
  20. ~~~~~~~~~~~~
  21. This document details the method RemoteAccess uses for inter-node
  22. communications, and how developers can utilise it in their own programs.
  23. Note that the hooks provided for user to user messaging are only enabled
  24. when RemoteAccess is running in multi-node mode (obviously).
  25.  
  26.  
  27. SENDING A MESSAGE TO AN ONLINE USER
  28. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  29. RemoteAccess periodically checks for the existence of a text file in the
  30. RemoteAccess system directory, named in the following manner:
  31.  
  32.         NODEnn.RA
  33.  
  34. Where nn is a number from 1 to 99, padded with a leading zero if in the
  35. range 1 to 9, of the node number the message is addressed to.
  36.  
  37. If the file is present it will be processed immediately as would any
  38. *.ASC / *.ANS text file. Thus it may contain any valid text file control
  39. code, detailed in the current RA.DOC.
  40.  
  41. The only preprocessing RemoteAccess performs is to set the text colour to
  42. white on black (if ANSI is enabled), and to sound the user's bell.
  43.  
  44.  
  45. EXAMPLE : Send a message to a user on line 3
  46. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  47. Create a file that contains the message text called NODE03.RA in the system
  48. directory, for example:
  49.  
  50. -------------- cut ----------------
  51. *MESSAGE* from Peter User on line 2:
  52. Yo John! Want to chat? 
  53.  
  54. Press [Return] to continue:
  55. -------------- cut ----------------
  56.  
  57. Note the use of the ^A character to force RemoteAccess to wait for the user
  58. to press [Return]. Without this the message would be immediately scrolled
  59. off the screen.
  60.  
  61.  
  62. EXAMPLE : Disconnect the user on line 14 immediately
  63. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  64. Create a file called NODE14.RA in the system directory that contains the
  65. following text:
  66.  
  67. -------------- cut ----------------
  68. *SYSTEM MAINTENANCE MANAGER requests you to disconnect immediately*
  69. 
  70. X
  71. -------------- cut ----------------
  72.  
  73. The first line displays the logoff message to the user, the second line
  74. uses the ^W control code to pause for five seconds, and the third line
  75. disconnects the user with the ^KX code.
  76.  
  77. With a little imagination, you can force RemoteAccess to do almost anything
  78. remotely. A text file with a ^X text file control code could be used to
  79. automatically execute an external program "on the fly".
  80.  
  81.  
  82.                        --- end of file RA_INC.DOC ---
  83.